home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cato / Xm / XmDisplay.z / XmDisplay
Encoding:
Text File  |  1998-10-20  |  19.8 KB  |  331 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             XXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmDDDDiiiissssppppllllaaaayyyy - The Display widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////DDDDiiiissssppppllllaaaayyyy....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents version 1.2 of the Motif library.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           The XmDisplay object is used by the Motif widgets to store
  20.           information that is specific to a display.  It also allows
  21.           the toolkit to access certain information on widget
  22.           hierarchies that would otherwise be unavailable.  Each
  23.           client has one XmDisplay object for each display it
  24.           accesses.
  25.  
  26.           An XmDisplay object is automatically created when the
  27.           application creates the first shell on a display (usually
  28.           accomplished by a call to XXXXttttAAAAppppppppIIIInnnniiiittttiiiiaaaalllliiiizzzzeeee or
  29.           XXXXttttAAAAppppppppCCCCrrrreeeeaaaatttteeeeSSSShhhheeeellllllll).  It is not necessary to create an
  30.           XmDisplay object by any other means.  An application can use
  31.           the function XXXXmmmmGGGGeeeettttXXXXmmmmDDDDiiiissssppppllllaaaayyyy to obtain the widget ID of the
  32.           XmDisplay object for a given display.
  33.  
  34.           An application cannot supply initial values for XmDisplay
  35.           resources as arguments to a call to any function that
  36.           creates widgets.  The application or user can supply initial
  37.           values in a resource file.  After creating the first shell
  38.           on the display, the application can use XXXXmmmmGGGGeeeettttXXXXmmmmDDDDiiiissssppppllllaaaayyyy to
  39.           obtain the widget ID of the XmDisplay object and then call
  40.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss to set the XmDisplay resources.
  41.  
  42.           XmDisplay resources specify the drag protocol style for a
  43.           client participating in drag and drop transactions.  There
  44.           are two basic protocol types, preregister and dynamic.  When
  45.           a preregister protocol is used, the toolkit handles any
  46.           communication between the initiator and receiver clients,
  47.           and displays the appropriate drag-over and drag-under visual
  48.           effects.  A client registers its drop sites in advance and
  49.           this information is stored in a property for each top-level
  50.           window.  When the drag pointer enters a top level window,
  51.           the drop site information is read by the initiator.  A
  52.           dynamic protocol allows the source and destination clients
  53.           to dynamically communicate drag and drop state information
  54.           between each other, and to update their respective visuals
  55.           accordingly.  The toolkit provides drop site information as
  56.           the pointer passes over any given drop site.  In this mode,
  57.           a receiver can supply a procedure to generate its own drag-
  58.           under effects.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             XXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))
  71.  
  72.  
  73.  
  74.         CCCCllllaaaasssssssseeeessss
  75.           Display inherits behavior and resources from CCCCoooorrrreeee,
  76.           CCCCoooommmmppppoooossssiiiitttteeee, SSSShhhheeeellllllll, WWWWMMMMSSSShhhheeeellllllll, VVVVeeeennnnddddoooorrrrSSSShhhheeeellllllll, TTTTooooppppLLLLeeeevvvveeeellllSSSShhhheeeellllllll, and
  77.           AAAApppppppplllliiiiccccaaaattttiiiioooonnnnSSSShhhheeeellllllll classes.
  78.  
  79.           The class pointer is xxxxmmmmDDDDiiiissssppppllllaaaayyyyCCCCllllaaaassssssss.
  80.  
  81.           The class name is XXXXmmmmDDDDiiiissssppppllllaaaayyyy.
  82.  
  83.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  84.           The following table defines a set of widget resources used
  85.           by the programmer to specify data.  The programmer can also
  86.           set the resource values for the inherited classes to set
  87.           attributes for this widget.  To reference a resource by name
  88.           or by class in an ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  89.           prefix and use the remaining letters.  To specify one of the
  90.           defined values for a resource in an ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove
  91.           the XXXXmmmm prefix and use the remaining letters (in either
  92.           lowercase or uppercase, but include any underscores between
  93.           words).  The codes in the access column indicate if the
  94.           given resource can be set at creation time (CCCC), set by using
  95.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (SSSS), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (GGGG), or is
  96.           not applicable (NNNN////AAAA).
  97.  
  98.                                                    XXXXmmmmDDDDiiiissssppppllllaaaayyyy RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  99.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt                     AAAAcccccccceeeessssssss
  100.      __________________________________________________________________________________________________________________
  101.      XmNdefaultVirtualBindings       DefaultVirtualBindings          String          dynamic                     CG
  102.      XmNdragInitiatorProtocolStyle   XmCDragInitiatorProtocolStyle   unsigned char   XmDRAG_PREFER_RECEIVER      CG
  103.      XmNdragReceiverProtocolStyle    XmCDragReceiverProtocolStyle    unsigned char   XmDRAG_PREFER_PREREGISTER   CG
  104.  
  105.           XXXXmmmmNNNNddddeeeeffffaaaauuuullllttttVVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss
  106.                     Specifies the default virtual bindings for the
  107.                     display.  Following is an example of a
  108.                     specification for the ddddeeeeffffaaaauuuullllttttVVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss
  109.                     resource in a resource file:
  110.  
  111.                     *defaultVirtualBindings: \
  112.                          osfBackSpace   :    <Key>BackSpace\n\
  113.                          osfInsert      :    <Key>InsertChar\n\
  114.                     ...
  115.                          osfDelete      :    <Key>DeleteChar
  116.  
  117.  
  118.           XXXXmmmmNNNNddddrrrraaaaggggIIIInnnniiiittttiiiiaaaattttoooorrrrPPPPrrrroooottttooooccccoooollllSSSSttttyyyylllleeee
  119.                     Specifies the drag and drop protocol requirements
  120.                     or preference when the client is an initiator.
  121.                     The possible values are
  122.  
  123.  
  124.                     XXXXmmmmDDDDRRRRAAAAGGGG____PPPPRRRREEEERRRREEEEGGGGIIIISSSSTTTTEEEERRRR
  125.                       As an initiator, this client does not use the
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             XXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                       dynamic protocol and can only arrange visual
  141.                       effects with receivers who provide preregistered
  142.                       information.
  143.  
  144.                     XXXXmmmmDDDDRRRRAAAAGGGG____DDDDYYYYNNNNAAAAMMMMIIIICCCC
  145.                       As an initiator, this client does not make use
  146.                       of any preregistered drop site information made
  147.                       available by other clients, and can only arrange
  148.                       visual effects with receivers who use the
  149.                       dynamic protocol.
  150.  
  151.                     XXXXmmmmDDDDRRRRAAAAGGGG____NNNNOOOONNNNEEEE
  152.                       Specifies that drag and drop is disabled for
  153.                       this client.
  154.  
  155.                     XXXXmmmmDDDDRRRRAAAAGGGG____DDDDRRRROOOOPPPP____OOOONNNNLLLLYYYY
  156.                       As an initiator, this client does not use either
  157.                       the preregistered drop site information or the
  158.                       dynamic protocol.  It supports dragging, and any
  159.                       time the cursor is over a client that supports
  160.                       drag and drop, valid feedback is provided.
  161.                       There are no other visual effects.
  162.  
  163.                     XXXXmmmmDDDDRRRRAAAAGGGG____PPPPRRRREEEEFFFFEEEERRRR____DDDDYYYYNNNNAAAAMMMMIIIICCCC
  164.                       As an initiator, this client can support both
  165.                       the preregister and dynamic protocols, but
  166.                       prefers to use dynamic protocols whenever
  167.                       possible in order to provide high-quality drag-
  168.                       under feedback.
  169.  
  170.                     XXXXmmmmDDDDRRRRAAAAGGGG____PPPPRRRREEEEFFFFEEEERRRR____PPPPRRRREEEERRRREEEEGGGGIIIISSSSTTTTEEEERRRR
  171.                       As an initiator, this client can support both
  172.                       the preregister and dynamic protocols, but
  173.                       prefers to use the preregister protocol whenever
  174.                       possible in order to accommodate performance
  175.                       needs or to provide consistent drag-over
  176.                       feedback.
  177.  
  178.                     XXXXmmmmDDDDRRRRAAAAGGGG____PPPPRRRREEEEFFFFEEEERRRR____RRRREEEECCCCEEEEIIIIVVVVEEEERRRR
  179.                       Indicates that this client can support both
  180.                       preregister and dynamic protocols, but will
  181.                       defer to the preference of the receiver client.
  182.                       This value is valid only for the
  183.                       XXXXmmmmNNNNddddrrrraaaaggggIIIInnnniiiittttiiiiaaaattttoooorrrrPPPPrrrroooottttooooccccoooollllSSSSttttyyyylllleeee resource, and is
  184.                       its default value.
  185.  
  186.  
  187.           XXXXmmmmNNNNddddrrrraaaaggggRRRReeeecccceeeeiiiivvvveeeerrrrPPPPrrrroooottttooooccccoooollllSSSSttttyyyylllleeee
  188.                     Specifies the drag and drop protocol requirements
  189.                     or preference when this client is a receiver.  The
  190.                     values are
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             XXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))
  203.  
  204.  
  205.  
  206.                     XXXXmmmmDDDDRRRRAAAAGGGG____PPPPRRRREEEERRRREEEEGGGGIIIISSSSTTTTEEEERRRR
  207.                       As a receiver, this client preregisters drop
  208.                       site information and does not use the dynamic
  209.                       protocol.  It can only arrange visual effects
  210.                       with initiators who make use of the
  211.                       preregistered information.
  212.  
  213.                     XXXXmmmmDDDDRRRRAAAAGGGG____DDDDYYYYNNNNAAAAMMMMIIIICCCC
  214.                       As a receiver, this client uses the dynamic
  215.                       protocol and does not preregister drop site
  216.                       information.  It can only arrange visual effects
  217.                       with initiators who use the dynamic protocol.
  218.  
  219.                     XXXXmmmmDDDDRRRRAAAAGGGG____NNNNOOOONNNNEEEE
  220.                       Specifies that drag and drop is disabled for
  221.                       this client.
  222.  
  223.                     XXXXmmmmDDDDRRRRAAAAGGGG____DDDDRRRROOOOPPPP____OOOONNNNLLLLYYYY
  224.                       As a receiver, this client neither uses the
  225.                       dynamic protocol nor preregisters drop site
  226.                       information.  It supports dropping, and when
  227.                       dragging over this client, valid feedback is
  228.                       always provided, but there are no other visual
  229.                       effects.
  230.  
  231.                     XXXXmmmmDDDDRRRRAAAAGGGG____PPPPRRRREEEEFFFFEEEERRRR____DDDDYYYYNNNNAAAAMMMMIIIICCCC
  232.                       As a receiver, this client can support both the
  233.                       preregister and dynamic protocols, but prefers
  234.                       to use dynamic protocol whenever possible in
  235.                       order to provide high-quality drag-under
  236.                       feedback.
  237.  
  238.                     XXXXmmmmDDDDRRRRAAAAGGGG____PPPPRRRREEEEFFFFEEEERRRR____PPPPRRRREEEERRRREEEEGGGGIIIISSSSTTTTEEEERRRR
  239.                       As a receiver, this client can support both the
  240.                       preregister and dynamic protocols, but prefers
  241.                       to use the preregister protocol whenever
  242.                       possible in order to accommodate performance
  243.                       needs.
  244.  
  245.  
  246.                     The actual protocol used between an initiator and
  247.                     a receiver is based on the protocol style of the
  248.                     receiver and initiator.  The decision matrix is as
  249.                     follows:
  250.  
  251.        DDDDrrrraaaagggg IIIInnnniiiittttiiiiaaaattttoooorrrr                     DDDDrrrraaaagggg RRRReeeecccceeeeiiiivvvveeeerrrr PPPPrrrroooottttooooccccoooollll SSSSttttyyyylllleeee
  252.        PPPPrrrroooottttooooccccoooollll SSSSttttyyyylllleeee   _______________________________________________________________
  253.                           PPPPrrrreeeerrrreeeeggggiiiisssstttteeeerrrr   PPPPrrrreeeeffffeeeerrrr PPPPrrrreeeerrrreeeeggggiiiisssstttteeeerrrr   PPPPrrrreeeeffffeeeerrrr DDDDyyyynnnnaaaammmmiiiicccc   DDDDyyyynnnnaaaammmmiiiicccc
  254.      __________________________________________________________________________________
  255.             PPPPrrrreeeerrrreeeeggggiiiisssstttteeeerrrr   Preregister   Preregister          Preregister      Drop Only
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             XXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX))))
  269.  
  270.  
  271.  
  272.      __________________________________________________________________________________
  273.      PPPPrrrreeeeffffeeeerrrr PPPPrrrreeeerrrreeeeggggiiiisssstttteeeerrrr   Preregister   Preregister          Preregister      Dynamic
  274.      __________________________________________________________________________________
  275.         PPPPrrrreeeeffffeeeerrrr RRRReeeecccceeeeiiiivvvveeeerrrr   Preregister   Preregister          Dynamic          Dynamic
  276.      __________________________________________________________________________________
  277.          PPPPrrrreeeeffffeeeerrrr DDDDyyyynnnnaaaammmmiiiicccc   Preregister   Dynamic              Dynamic          Dynamic
  278.      __________________________________________________________________________________
  279.                 DDDDyyyynnnnaaaammmmiiiicccc   Drop Only     Dynamic              Dynamic          Dynamic
  280.  
  281.                     The value XXXXmmmmDDDDRRRRAAAAGGGG____NNNNOOOONNNNEEEE does not appear in the above
  282.                     matrix.  When specified for either the initiator
  283.                     or receiver side, XXXXmmmmDDDDRRRRAAAAGGGG____NNNNOOOONNNNEEEE implies that drag
  284.                     and drop transactions are not supported.  A value
  285.                     of XXXXmmmmDDDDRRRRAAAAGGGG____DDDDRRRROOOOPPPP____OOOONNNNLLLLYYYY (Drop Only) results when an
  286.                     initiator and receiver cannot compromise protocol
  287.                     styles, that is, one client requires dynamic mode
  288.                     while the other can only support preregister mode,
  289.                     or if either explicitly has specified
  290.                     XXXXmmmmDDDDRRRRAAAAGGGG____DDDDRRRROOOOPPPP____OOOONNNNLLLLYYYY.
  291.  
  292.  
  293.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  294.           All of the superclass resources inherited by XmDisplay are
  295.           designated N/A (not applicable).
  296.  
  297.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  298.           AAAApppppppplllliiiiccccaaaattttiiiioooonnnnSSSShhhheeeellllllll((((3333XXXX)))), CCCCoooommmmppppoooossssiiiitttteeee((((3333XXXX)))), CCCCoooorrrreeee((((3333XXXX)))),
  299.           TTTTooooppppLLLLeeeevvvveeeellllSSSShhhheeeellllllll((((3333XXXX)))), VVVVeeeennnnddddoooorrrrSSSShhhheeeellllllll((((3333XXXX)))), WWWWMMMMSSSShhhheeeellllllll((((3333XXXX)))),
  300.           XXXXmmmmGGGGeeeettttXXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX)))), and XXXXmmmmSSSSccccrrrreeeeeeeennnn((((3333XXXX)))).
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 4/30/98)
  328.  
  329.  
  330.  
  331.